<HTML>
<BODY BGCOLOR="white">
<PRE>
<FONT color="green">001</FONT>    package org.hackystat.sensor.xmldata.option;<a name="line.1"></a>
<FONT color="green">002</FONT>    <a name="line.2"></a>
<FONT color="green">003</FONT>    import java.util.List;<a name="line.3"></a>
<FONT color="green">004</FONT>    <a name="line.4"></a>
<FONT color="green">005</FONT>    /**<a name="line.5"></a>
<FONT color="green">006</FONT>     * The common interface between objects that wrap the options and parameters<a name="line.6"></a>
<FONT color="green">007</FONT>     * specified via command-line arguments. Options provide the capability to store<a name="line.7"></a>
<FONT color="green">008</FONT>     * the passed options and arguments, validate the parameters, and execute an<a name="line.8"></a>
<FONT color="green">009</FONT>     * action over the parameters.<a name="line.9"></a>
<FONT color="green">010</FONT>     * @author Austen Ito<a name="line.10"></a>
<FONT color="green">011</FONT>     * <a name="line.11"></a>
<FONT color="green">012</FONT>     */<a name="line.12"></a>
<FONT color="green">013</FONT>    public interface Option {<a name="line.13"></a>
<FONT color="green">014</FONT>      /**<a name="line.14"></a>
<FONT color="green">015</FONT>       * Returns true if this option's parameters are valid.<a name="line.15"></a>
<FONT color="green">016</FONT>       * @return true if all parameters are valid.<a name="line.16"></a>
<FONT color="green">017</FONT>       */<a name="line.17"></a>
<FONT color="green">018</FONT>      public boolean isValid();<a name="line.18"></a>
<FONT color="green">019</FONT>    <a name="line.19"></a>
<FONT color="green">020</FONT>      /**<a name="line.20"></a>
<FONT color="green">021</FONT>       * Returns the name of this option.<a name="line.21"></a>
<FONT color="green">022</FONT>       * @return the option name.<a name="line.22"></a>
<FONT color="green">023</FONT>       */<a name="line.23"></a>
<FONT color="green">024</FONT>      public String getName();<a name="line.24"></a>
<FONT color="green">025</FONT>    <a name="line.25"></a>
<FONT color="green">026</FONT>      /**<a name="line.26"></a>
<FONT color="green">027</FONT>       * Processes the parameters found in this option. This method is called before<a name="line.27"></a>
<FONT color="green">028</FONT>       * execution and can be used to setup option values or perform pre-execution<a name="line.28"></a>
<FONT color="green">029</FONT>       * processing.<a name="line.29"></a>
<FONT color="green">030</FONT>       */<a name="line.30"></a>
<FONT color="green">031</FONT>      public void process();<a name="line.31"></a>
<FONT color="green">032</FONT>    <a name="line.32"></a>
<FONT color="green">033</FONT>      /**<a name="line.33"></a>
<FONT color="green">034</FONT>       * Returns a list of parameters used to execute this option.<a name="line.34"></a>
<FONT color="green">035</FONT>       * @return the list of parameters.<a name="line.35"></a>
<FONT color="green">036</FONT>       */<a name="line.36"></a>
<FONT color="green">037</FONT>      public List&lt;String&gt; getParameters();<a name="line.37"></a>
<FONT color="green">038</FONT>    <a name="line.38"></a>
<FONT color="green">039</FONT>      /**<a name="line.39"></a>
<FONT color="green">040</FONT>       * Executes this option based on the option name and parameters.<a name="line.40"></a>
<FONT color="green">041</FONT>       */<a name="line.41"></a>
<FONT color="green">042</FONT>      public void execute();<a name="line.42"></a>
<FONT color="green">043</FONT>    }<a name="line.43"></a>




























































</PRE>
</BODY>
</HTML>
